Skip to main content

Public Single Address Search

POST /api/v1/searches/public/single/address

Description​

Perform a public single address search.

Path Parameters​

NameTypeDescription
NoneNo parameters

Request Body​

  • Content Type: application/json
{
  "address": "string",
  "isAddressOnly": true,
  "country": {
    "name": "string",
    "code": "string",
    "currency": "string"
  },
  "state": {
    "name": "string",
    "code": "string"
  },
  "lga": {
    "name": "string",
    "code": "string"
  }
}

Response Code: 201 - Created Description

The address search was successfully created.

Headers​

Content-TypeValue
apiKey{{apiKey}}
useridstring

Body​

{
  "address": "123 Main St",
  "isAddressOnly": true,
  "country": {
    "name": "CountryName",
    "code": "CN",
    "currency": "Currency"
  },
  "state": {
    "name": "StateName",
    "code": "SN"
  },
  "lga": {
    "name": "LGAName",
    "code": "LGA"
  }
}

🔑 Authentication bearer​

ParamValueType
token{{accessCode}}string

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /api/v1/searches/public/single/address \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!